Early Access: The content on this website is provided for informational purposes only in connection with pre-General Availability Qlik Products.
All content is subject to change and is provided without warranty.
Skip to main content Skip to complementary content
Qlik Resources

Running tasks using the CLI

Before you can run a task, you must first run the Connect command as described in Connecting to Qlik Compose server.

Information note

As Compose CLI requires Administrator permission, make sure to select "Run as administrator" when opening the command prompt.

The run_task command populates the data warehouse or data mart with data. The "ETL" operation can also be performed using the Run toolbar button located in Monitor view as well as in the Manage Data Warehouse Tasks and Manage Data Marts windows.

When this command succeeds, it returns 0.

Command syntax

ComposeCli.exe run_task --project project_name --type DW|DM|WF --task task_name --wait timeout_in_sec

Parameters

Parameter Description
--project The name of the project.
--type The type of tables that you want to populate. Specify DW to populate a data warehouse, DM to populate a data mart, or WF to run a workflow.
--task

When:

  • --type DW, this should be specified as the name of the task that you want to run.

  • --type DM, this should be specified as the name of the data mart that you want to populate.

  • --type WF, this should be specified as the name of the workflow that you want to run.
--wait

The wait time specified in seconds.

The command line can run in sync or async mode. A value of 0 (seconds) indicates sync mode. This means that as soon as the task finishes, the command line returns to prompt. The default mode is async, with a value of -1. This is also applied if you leave this parameter empty. Other negative values are not permitted.

Note that if wait is excluded from the command, the task may appear to complete successfully even if it encountered an error.

Example

ComposeCli.exe run_task --project MyProject --type DW --task DWH1 --wait 1

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here